/*
 * JHeuristics - The Java Meta-Heuritics Library
 * Copyright (C) 2004-2005, Universidade Federal de Campina Grande. All rights reserved.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package org.jheuristics.ga.operators;

import org.jheuristics.ga.DefaultPopulation;
import org.jheuristics.ga.GAConfig;
import org.jheuristics.ga.GAStatus;
import org.jheuristics.ga.Population;

/**
 * TODO
 *
 * @author Marcell Manfrin, marcell@ourgrid.org, Jan 9, 2006
 */
public abstract class AbstractReproductionOperator extends AbstractSelectionOperator {
    private Reproductor reproductor;

    /**
     * TODO
     *
     * @param rate
     * @param probability
     * @param selector
     * @param reproductor
     */
    public AbstractReproductionOperator(Rate rate, Selector selector, Reproductor reproductor) {
        super(rate, selector);
        setReproductor(reproductor);
    }

    /**
     * TODO
     *
     * @param status
     * @param config
     * @see org.jheuristics.ga.Operator#operate(org.jheuristics.ga.GAStatus, org.jheuristics.ga.GAConfig)
     */
    public abstract void operate(GAStatus status, GAConfig config);

    /**
     * TODO
     *
     * @param population
     * @param status
     * @param config
     * @return
     */
    protected Population reproduce(Population population, GAStatus status, GAConfig config) {
        Selector selector = getSelector();
        Reproductor reproductor = getReproductor();
        int rate = getRate().rate(status, config);

        Population result = new DefaultPopulation();
        if (0 != reproductor.getRequiredNumberOfParents()) {
        	int required = reproductor.getRequiredNumberOfParents();
	        for (int i = 0; i < rate; i++) {
	            result.addIndividuals(reproductor.reproduce(selector.select(population, required, status, config), status, config));
	        }
        } else {
            result.addIndividuals(reproductor.reproduce(selector.select(population, rate, status, config), status, config));
        }
        return result;
    }

    /**
     * TODO
     *
     * @return Returns the reproductor.
     */
    public Reproductor getReproductor() {
        return reproductor;
    }

    /**
     * TODO
     *
     * @param reproductor The reproductor to set.
     */
    public void setReproductor(Reproductor reproductor) {
		if (null == reproductor) {
			// TODO: ERROR MSG
			throw new NullPointerException();
		}
        this.reproductor = reproductor;
    }

}
